<HTML><HEAD><TITLE>aggregate_result(+File)</TITLE>
</HEAD><BODY>[ <A HREF="index.html">library(instprofile)</A> | <A HREF="../../index.html">Reference Manual</A> | <A HREF="../../fullindex.html">Alphabetic Index</A> ]
<H1>aggregate_result(+File)</H1>
Write the aggregated instrument profiling results to
   a named file.
<DL>
<DT><EM>File</EM></DT>
<DD>Atom or string
</DD>
</DL>
<H2>Description</H2>
<P>    
   This will write the aggregated results of instrumentation profiling 
   for all source files that have been compiled into the calling module 
   context and profiled with the instrument profiler.
   </P><P>
   NOTE: Memory related statistics are displayed in kilobytes not bytes.
   </P><P>
   This predicate should be executed before result/0 predicate, since
   result/0 also invokes reset/0 which resets the statistics.
   </P><P>
   The use of this predicate is only meaningful if the module has
   previously been compiled for instrumentation profiling using 
   <TT>instprofile:statprofile/2,3</TT>, and the code has been
   run in order to obtain profiling results.
   </P><P>
   The predicate is a tool and the profiling results of a
   module other than the current calling module context can be obtained
   by invoking <TT>aggregate_result@Module</TT>.
   </P>
<H3>Modules</H3>
This predicate is sensitive to its module context (tool predicate, see @/2).
<H3>Fail Conditions</H3>
The calling context module has not been profiled.
<H3>Resatisfiable</H3>
no
<H3>Exceptions</H3>
<DL>
<DT><EM>(4) instantiation fault </EM>
<DD>File is not instantiated
<DT><EM>(5) type error </EM>
<DD>File is not an atom or string
</DL>
<H2>See Also</H2>
<A HREF="../../lib/instprofile/statprofile-2.html">statprofile / 2</A>, <A HREF="../../lib/instprofile/statprofile-3.html">statprofile / 3</A>, <A HREF="../../lib/instprofile/aggregate_result-1.html">aggregate_result / 1</A>, <A HREF="../../lib/instprofile/open_delta_file-1.html">open_delta_file / 1</A>, <A HREF="../../lib/instprofile/close_delta_file-0.html">close_delta_file / 0</A>, <A HREF="../../lib/instprofile/reset-0.html">reset / 0</A>, <A HREF="../../kernel/env/statistics-2.html">statistics / 2</A>, <A HREF="../../lib/instprofile/index.html">library(instprofile)</A>
</BODY></HTML>
